/*
 * Copyright (C) 2011 by Fabien Barbero
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.flickr.api.auth;

import com.flickr.api.FlickrServiceException;
import java.net.URI;

/**
 * http://www.flickr.com/services/api/auth.howto.desktop.html
 *
 * @author Fabien Barbero
 */
public interface AuthenticationService {

    /**
     * Get the URI of the authentication web page. The frob is automatically
     * managed in this method.
     *
     * @return The URI of the web page.
     * @throws FlickrServiceException Error getting the URI.
     */
    URI getAuthPage()
            throws FlickrServiceException;

    Caller authenticate()
            throws FlickrServiceException;

    /**
     * Logout of the user.
     *
     * @throws AuthenticationException Logout failure.
     */
    void logout()
            throws FlickrServiceException;
}
